home *** CD-ROM | disk | FTP | other *** search
/ The CICA Windows Explosion! / The CICA Windows Explosion! - Disc 2.iso / programr / rc2hdk30.zip / RC2HDK.DOC < prev    next >
Text File  |  1994-04-25  |  10KB  |  385 lines
  1.                                   - TOC-   1 -
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  RC2HDK - Resource To HLPDK Help Template Generator ...................      1
  8.  System Requirements ..................................................      1
  9.  What's New ...........................................................      1
  10.  File List - List of files available with RC2HDK ......................      2
  11.  Registering RC2HDK ...................................................      2
  12.  Contact ..............................................................      3
  13.  HLPDK - The Help Development Kit .....................................      3
  14.  OPERATION ............................................................      3
  15.  Credits ..............................................................      4
  16.  Warranty .............................................................      4
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.                                   - TOC-   1 -
  65.                                     -    1 -
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72. RC2HDK - Resource To HLPDK Help Template Generator▄
  73.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  74.  
  75. RC2HDK is a program that takes Windows RC (Resource Description) files, and
  76. creates a HLPDK help template from it.
  77.  
  78. Resources are used to describe the part of the program the users see, in here 
  79. we define Menu entries, Dialog boxes, Key Accelerators and more. Since the
  80. users need to see help on the program's interface, more than anything else,
  81. the place to look for the help template for your windows programs - is in
  82. the resource file.
  83.  
  84. RC2HDK takes that file, and creates the template for you, saving you time,
  85. and helping you with the design of your help system. HLPDK is used to
  86. convert the output of RC2HDK to winHelp source files, or - you can even
  87. create the template for your text and wordprocessor documentation from
  88. this same output.
  89.  
  90. This version of RC2HDK supports Dialog, Menu and Accelerator resources.
  91.  
  92.  
  93.  
  94. What's New▄
  95.  ▀▀▀▀▀▀▀▀▀▀
  96.  
  97. Version 3.0
  98.  
  99.         - Added dialog resource template generation.
  100.  
  101.         - This version creates topics with external references that can
  102.           be easly called by your programs using the winhelp function.
  103.  
  104.         - Support for BC++/4 Resource Workshop Style RC files.
  105.  
  106. Version 2.0
  107.  
  108.         - Added the /MT+ and /MP+ switches to the RC2HDK program, use the
  109.           /MT+ switch to generate menu-items topic help entries, instead
  110.           of the default popup entries. RC2HDK will create topics with 
  111.           external reference, so it will be easy for you to call these 
  112.           entries from your program.
  113.  
  114.         - Added Accelerator resource template generation.
  115.  
  116. Version 1.0 - Initial Version.
  117.  
  118.  
  119. System Requirements▄
  120.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  121.  
  122. In order to use RC2HDK you need :
  123.  
  124. - This Package
  125.  
  126.  
  127.  
  128.                    rc2hdk, Page #   1   Date 25-4-1994 Monday
  129.                                     -    2 -
  130.  
  131.  
  132.  
  133.  
  134.  
  135. - The RC sources for your windows programs
  136. - The Help Development Kit Sound & Vision Edition (10.0) or later.
  137. - The HC31 or HCP program that came with your Language Compiler.
  138. - A PC capable of running DPMI programs.
  139.  
  140. Optional :
  141.  
  142. - Help Compilers/Linkers to specific targets.
  143.  
  144.  
  145. File List - List of files available with RC2HDK▄
  146.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  147.  
  148. List of files available with the RC2HDK package :
  149.  
  150. RC2HDK.EXE      - The RC2HDK help template generator.
  151. RC2HDK.DOC      - This File.
  152. RC2HDK.HLP      - RC2HDK Documentation in winHelp Format.
  153. RC2HDK.REG      - HLPDK+RC2HDK Registration File.
  154. RC2HDK.EDU      - HLPDK+RC2HDK Registration File/Education discount.
  155. PROGRAMS.TXT    - HyperAct Inc. shareware products description.
  156.  
  157.  
  158. Registering RC2HDK▄
  159.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  160.  
  161. The RC2HDK system is NOT Free!, Only registered HLPDK users are allowed to
  162. use it. If you find this product valuable, after a reasonable evaluation
  163. period, please register it and HLPDK. 
  164.  
  165. By Registaring you will receive the latest HLPDK system, that include protected 
  166. mode compilers and engines, and the latest RC2HDK system, with a protected
  167. mode RC2HDKX program!
  168.  
  169. To order your registered copy of HLPDK please do one of the following:
  170.  
  171.  1.     Order from HyperAct Inc.:     
  172.  You can order directly from HyperAct Inc. Please refer to the supplied 
  173.  RC2HDK.REG file. Edit it, print it and mail it (with a check) to: 
  174.         HyperAct Inc.,  
  175.         POBox 5517
  176.         Coralville Iowa 52241, U.S.A
  177.  
  178.  2.     Order from PsL:
  179.  You can order from Public (software) Library with your MC, Visa, AmEx 
  180.  or Discover card by calling 800-242-4PsL (from overseas: 713-524-6394) or 
  181.  by FAX to 713-524-6398 or by CompuServe to 71355,470. 
  182.  These numbers are for ordering only. HyperAct Inc. can NOT be reached at those 
  183.  numbers. Please contact HyperAct Inc. directly for any other type of problem 
  184.  (technical or other), information or request.
  185.  
  186. Registered HLPDK users can register RC2HDK at a reduced cost. Please refer to
  187. the supplied RC2HDK.REG file. Edit it, print it and mail it (with a check)
  188. to HyperAct Inc.
  189.  
  190.  
  191.  
  192.                    rc2hdk, Page #   2   Date 25-4-1994 Monday
  193.                                     -    3 -
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200. Special registration fees for higher education students and staff members.
  201. Please refer to the supplied RC2HDK.EDU file. Edit it, print it and mail it
  202. (with a check) to HyperAct Inc. (offered only when registering directly).
  203.  
  204.  
  205. Contact▄
  206.  ▀▀▀▀▀▀▀
  207.  
  208.   Please contact :
  209.  
  210.   HyperAct Inc.,  
  211.   P.O.B 5517
  212.   Coralville IA 52241,
  213.   U.S.A
  214.  
  215. HyperAct Inc. e-mail address : CompuServe - 76350,333
  216.  
  217.   To contact the author directly : 
  218.  
  219. e-mail address : CompuServe - 100274,162
  220.  
  221.  
  222. OPERATION▄
  223.  ▀▀▀▀▀▀▀▀▀
  224.  
  225. In order to use RC2HDK do the following :
  226.  
  227. 1. RC2HDK inpfile.RC
  228.  
  229. 2. Edit the output inpfile.HDF to include your custom help according to the
  230.    template generated.
  231.  
  232. 3. Use HELPC to create the target help database requested.
  233.    e.g. - HELPC /W31 INPFILE
  234.           HC31 INPFILE
  235.  
  236.  
  237. HLPDK - The Help Development Kit▄
  238.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  239.  
  240. The Help Development Kit is the hypertext package that is needed in order
  241. to compile and use the output of the RC2HDK system.
  242.  
  243. HLPDK includes a help compiler that accepts sources in the .HDF 
  244. (HLPDK Help Definition Format), and creates help databases to the HLPDK 
  245. help engines, or sources to other help engine targets, such as Windows
  246. winHelp, OS/2 IPF, DESQVIEW/X help system, Borland's TVHC and THELP,
  247. Turbo Power's PopHelp, Microsoft's QuickHelp, Microsoft Multimedia Viewer,
  248. World Wide Web HTML and can even create text documents and word processors 
  249. documents. (This document was created using HLPDK). 
  250.  
  251. The HLPDK system includes 2 Royalty Free Help Engines, that can be
  252. distributed free with help databases that were created by the help compiler.
  253.  
  254.  
  255.  
  256.                    rc2hdk, Page #   3   Date 25-4-1994 Monday
  257.                                     -    4 -
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264. HLPDK suports the following features :
  265.  
  266. Topics, PopUps, Links, Keywords, Text Formats, Navigational and
  267. Structural facilities, Target Code insertion, Multiple module files,
  268. Automatic Pascal/C/C++ reference generation, Exception handling,
  269. Multiple file target databases, Graphics, Sound, Groups, Application
  270. Launch, Automatic exports creation, User defined link templates,
  271. trigger actions and more.
  272.  
  273. Programmers that want the help engine's sources, can purchase it and modify
  274. it to their specific needs.
  275.  
  276. The HLPDK package is a shareware product, distributed by HyperAct Inc.
  277.  
  278.  
  279. Warranty▄
  280.  ▀▀▀▀▀▀▀▀
  281.  
  282. There is no warranty what so ever, The package is supplied as is,
  283. The distributor (HyperAct Inc), or the author (Loewy Ron), are not, 
  284. and will not be responsible for any damages, lost profits, 
  285. or inconveniences caused by the use, or inability to use this package. 
  286. The use of the program is at your own risk. 
  287. By using (or attempting to use) the package you agree to this.
  288.  
  289.  
  290.  
  291. Credits▄
  292.  ▀▀▀▀▀▀▀
  293.  
  294. The RC2HDK Program was created by Ron Loewy.
  295.  
  296. The RC2HDK Program was written using Borland Pascal with Objects 7.0,
  297. A trademark of Borland International.
  298.  
  299. Large parts of the RC2HDK Program were generated using my own dbGen CASE code
  300. generator.
  301.  
  302. Parts of the RC2HDK program were created using MKS LEX&YACC V3.2.
  303. A trademark of Mortice Kern Systems, Inc.
  304.  
  305. HELPENG, HELPC were written using Turbo Pascal 6.0, and Borland Pascal 7.0,
  306. Paradox Engine 2.0, and Paradox Engine 3.0, 3.01. 
  307. (Trademarks of Borland International).
  308.  
  309. Windows, Microsoft, HC and Quick Help are trademarks or copyrights
  310. of Microsoft Corp.
  311.  
  312. The HELPENG program was written using the WINTEXT UI library, 
  313. (c) 1991,93 Loewy Ron.
  314.  
  315. THELP, HL and TVHC are Trademarks or copyrights Borland International.
  316.  
  317.  
  318.  
  319.  
  320.                    rc2hdk, Page #   4   Date 25-4-1994 Monday
  321.                                     -    5 -
  322.  
  323.  
  324.  
  325.  
  326.  
  327. popHelp is a copyright of TurboPower Software.
  328.  
  329. DESQview/X is a trademark of Quarterdeck Office Systems.
  330.  
  331. OS/2 is a registered trademark of International Business Machines.
  332.  
  333. Parts of the Help Engines were generated using Ron Loewy's WTGEN and dbGen
  334. CASE code generators.
  335.  
  336. Parts of the Help Compiler were generated using Ron Loewy's dbGen database 
  337. code generator.
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.                    rc2hdk, Page #   5   Date 25-4-1994 Monday
  385.